<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <title>perlstyle - Perl style guide - Perldoc Browser</title>
    <link rel="search" href="https://perldoc.perl.org/opensearch.xml" type="application/opensearchdescription+xml" title="Perldoc Browser">
    <link rel="canonical" href="https://perldoc.perl.org/perlstyle">
    <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.5.2/css/bootstrap.min.css" integrity="sha384-JcKb8q3iqJ61gNV9KGb8thSsNjpSL0n8PARn9HuZOnIxN0hoP+VmmDGMN5t9UJ0Z" crossorigin="anonymous">
    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/stackoverflow-light.min.css" integrity="sha512-cG1IdFxqipi3gqLmksLtuk13C+hBa57a6zpWxMeoY3Q9O6ooFxq50DayCdm0QrDgZjMUn23z/0PMZlgft7Yp5Q==" crossorigin="anonymous" />
    <style>
      body {
        background: #f4f4f5;
        color: #020202;
      }
      .navbar-dark {
        background-image: -webkit-linear-gradient(top, #005f85 0, #002e49 100%);
        background-image: -o-linear-gradient(top, #005f85 0, #002e49 100%);
        background-image: linear-gradient(to bottom, #005f85 0, #002e49 100%);
        filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#ff005f85', endColorstr='#ff002e49', GradientType=0);
        background-repeat: repeat-x;
      }
      .navbar-dark .navbar-nav .nav-link,
      .navbar-dark .navbar-nav .nav-link:focus { color: #fff }
      .navbar-dark .navbar-nav .nav-link:hover { color: #ffef68 }
      #wrapperlicious {
        margin: 0 auto;
        font: 0.9em 'Helvetica Neue', Helvetica, sans-serif;
        font-weight: normal;
        line-height: 1.5em;
        margin: 0;
        padding: 0;
      }
      #wrapperlicious h1 { font-size: 1.5em }
      #wrapperlicious h2 { font-size: 1.3em }
      #wrapperlicious h3 { font-size: 1.1em }
      #wrapperlicious h4 { font-size: 0.9em }
      #wrapperlicious h1, #wrapperlicious h2, #wrapperlicious h3,
      #wrapperlicious h4, #wrapperlicious dt {
        color: #020202;
        margin-top: 1em;
        margin-bottom: 1em;
        position: relative;
        font-weight: bold;
      }
      #wrapperlicious a { color: inherit; text-decoration: underline }
      #wrapperlicious #toc { text-decoration: none }
      #wrapperlicious a:hover { color: #2a2a2a }
      #wrapperlicious a img { border: 0 }
      #wrapperlicious :not(pre) > code {
        color: inherit;
        background-color: rgba(0, 0, 0, 0.04);
        border-radius: 3px;
        font: 0.9em Consolas, Menlo, Monaco, monospace;
        padding: 0.3em;
      }
      #wrapperlicious dd {
        margin: 0;
        margin-left: 2em;
      }
      #wrapperlicious dt {
        color: #2a2a2a;
        font-weight: bold;
        margin-left: 0.9em;
      }
      #wrapperlicious p {
        margin-bottom: 1em;
        margin-top: 1em;
      }
      #wrapperlicious li > p {
        margin-bottom: 0;
        margin-top: 0;
      }
      #wrapperlicious pre {
        border: 1px solid #c1c1c1;
        border-radius: 3px;
        font: 100% Consolas, Menlo, Monaco, monospace;
        margin-bottom: 1em;
        margin-top: 1em;
      }
      #wrapperlicious pre > code {
        display: block;
        background-color: #f6f6f6;
        font: 0.9em Consolas, Menlo, Monaco, monospace;
        line-height: 1.5em;
        text-align: left;
        white-space: pre;
        padding: 1em;
      }
      #wrapperlicious dl, #wrapperlicious ol, #wrapperlicious ul {
        margin-bottom: 1em;
        margin-top: 1em;
      }
      #wrapperlicious ul {
        list-style-type: square;
      }
      #wrapperlicious ul ul {
        margin-bottom: 0px;
        margin-top: 0px;
      }
      #footer {
        font-size: 0.8em;
        padding-top: 0.5em;
        text-align: center;
      }
      #more {
        display: inline;
        font-size: 0.8em;
      }
      #perldocdiv {
        background-color: #fff;
        border: 1px solid #c1c1c1;
        border-bottom-left-radius: 5px;
        border-bottom-right-radius: 5px;
        margin-left: auto;
        margin-right: auto;
        padding: 3em;
        padding-top: 1em;
        max-width: 960px;
      }
      #moduleversion { float: right }
      #wrapperlicious .leading-notice {
        font-style: italic;
        padding-left: 1em;
        margin-top: 1em;
        margin-bottom: 1em;
      }
      #wrapperlicious .permalink {
        display: none;
        left: -0.75em;
        position: absolute;
        padding-right: 0.25em;
        text-decoration: none;
      }
      #wrapperlicious h1:hover .permalink, #wrapperlicious h2:hover .permalink,
      #wrapperlicious h3:hover .permalink, #wrapperlicious h4:hover .permalink,
      #wrapperlicious dt:hover .permalink {
        display: block;
      }
    </style>
    <!-- Global site tag (gtag.js) - Google Analytics -->
    <script async src="https://www.googletagmanager.com/gtag/js?id=G-KVNWBNT5FB"></script>
    <script>
      window.dataLayer = window.dataLayer || [];
      function gtag(){dataLayer.push(arguments);}
      gtag('js', new Date());

      gtag('config', 'G-KVNWBNT5FB');
      gtag('config', 'UA-50555-3');
    </script>
  </head>
  <body>
    <nav class="navbar navbar-expand-md navbar-dark bg-dark justify-content-between">
  <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarNav" aria-controls="navbarNav" aria-expanded="false" aria-label="Toggle navigation">
    <span class="navbar-toggler-icon"></span>
  </button>
  <a class="navbar-brand" href="https://perldoc.perl.org/">Perldoc Browser</a>
  <div class="collapse navbar-collapse" id="navbarNav">
    <ul class="navbar-nav mr-auto">
      <li class="nav-item dropdown text-nowrap">
        <a class="nav-link dropdown-toggle" href="perlstyle.html#" id="dropdownlink-stable" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">5.35.0</a>
        <div class="dropdown-menu" aria-labelledby="dropdownlink-stable">
          <a class="dropdown-item" href="https://perldoc.perl.org/perlstyle">Latest</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.38.2/perlstyle">5.38.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.38.1/perlstyle">5.38.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.38.0/perlstyle">5.38.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.36.3/perlstyle">5.36.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.36.2/perlstyle">5.36.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.36.1/perlstyle">5.36.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.36.0/perlstyle">5.36.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.34.3/perlstyle">5.34.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.34.2/perlstyle">5.34.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.34.1/perlstyle">5.34.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.34.0/perlstyle">5.34.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.32.1/perlstyle">5.32.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.32.0/perlstyle">5.32.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.30.3/perlstyle">5.30.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.30.2/perlstyle">5.30.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.30.1/perlstyle">5.30.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.30.0/perlstyle">5.30.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.28.3/perlstyle">5.28.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.28.2/perlstyle">5.28.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.28.1/perlstyle">5.28.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.28.0/perlstyle">5.28.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.26.3/perlstyle">5.26.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.26.2/perlstyle">5.26.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.26.1/perlstyle">5.26.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.26.0/perlstyle">5.26.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.24.4/perlstyle">5.24.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.24.3/perlstyle">5.24.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.24.2/perlstyle">5.24.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.24.1/perlstyle">5.24.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.24.0/perlstyle">5.24.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.22.4/perlstyle">5.22.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.22.3/perlstyle">5.22.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.22.2/perlstyle">5.22.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.22.1/perlstyle">5.22.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.22.0/perlstyle">5.22.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.20.3/perlstyle">5.20.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.20.2/perlstyle">5.20.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.20.1/perlstyle">5.20.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.20.0/perlstyle">5.20.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.18.4/perlstyle">5.18.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.18.3/perlstyle">5.18.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.18.2/perlstyle">5.18.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.18.1/perlstyle">5.18.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.18.0/perlstyle">5.18.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.16.3/perlstyle">5.16.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.16.2/perlstyle">5.16.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.16.1/perlstyle">5.16.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.16.0/perlstyle">5.16.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.14.4/perlstyle">5.14.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.14.3/perlstyle">5.14.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.14.2/perlstyle">5.14.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.14.1/perlstyle">5.14.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.14.0/perlstyle">5.14.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.12.5/perlstyle">5.12.5</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.12.4/perlstyle">5.12.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.12.3/perlstyle">5.12.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.12.2/perlstyle">5.12.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.12.1/perlstyle">5.12.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.12.0/perlstyle">5.12.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.10.1/perlstyle">5.10.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.10.0/perlstyle">5.10.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.9/perlstyle">5.8.9</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.8/perlstyle">5.8.8</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.7/perlstyle">5.8.7</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.6/perlstyle">5.8.6</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.5/perlstyle">5.8.5</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.4/perlstyle">5.8.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.3/perlstyle">5.8.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.2/perlstyle">5.8.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.1/perlstyle">5.8.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.0/perlstyle">5.8.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.6.2/perlstyle">5.6.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.6.1/perlstyle">5.6.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.6.0/perlstyle">5.6.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.005_04/perlstyle">5.005_04</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.005_03/perlstyle">5.005_03</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.005_02/perlstyle">5.005_02</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.005_01/perlstyle">5.005_01</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.005/perlstyle">5.005</a>
        </div>
      </li>
      <li class="nav-item dropdown text-nowrap">
        <a class="nav-link dropdown-toggle" href="perlstyle.html#" id="dropdownlink-dev" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Dev</a>
        <div class="dropdown-menu" aria-labelledby="dropdownlink-dev">
          <a class="dropdown-item" href="https://perldoc.perl.org/blead/perlstyle">blead</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.39.6/perlstyle">5.39.6</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.39.5/perlstyle">5.39.5</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.39.4/perlstyle">5.39.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.39.3/perlstyle">5.39.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.39.2/perlstyle">5.39.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.39.1/perlstyle">5.39.1</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.38.0-RC2/perlstyle">5.38.0-RC2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.38.0-RC1/perlstyle">5.38.0-RC1</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.11/perlstyle">5.37.11</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.10/perlstyle">5.37.10</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.9/perlstyle">5.37.9</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.8/perlstyle">5.37.8</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.7/perlstyle">5.37.7</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.6/perlstyle">5.37.6</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.5/perlstyle">5.37.5</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.4/perlstyle">5.37.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.3/perlstyle">5.37.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.2/perlstyle">5.37.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.1/perlstyle">5.37.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.0/perlstyle">5.37.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.11/perlstyle">5.35.11</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.10/perlstyle">5.35.10</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.9/perlstyle">5.35.9</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.8/perlstyle">5.35.8</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.7/perlstyle">5.35.7</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.6/perlstyle">5.35.6</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.5/perlstyle">5.35.5</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.4/perlstyle">5.35.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.3/perlstyle">5.35.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.2/perlstyle">5.35.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.1/perlstyle">5.35.1</a>
          <a class="dropdown-item active" href="perlstyle.html">5.35.0</a>
        </div>
      </li>
      <li class="nav-item dropdown text-nowrap">
        <a class="nav-link dropdown-toggle" href="perlstyle.html#" id="dropdownlink-nav" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Documentation</a>
        <div class="dropdown-menu" aria-labelledby="dropdownlink-nav">
          <a class="dropdown-item" href="perl.html">Perl</a>
          <a class="dropdown-item" href="perlintro.html">Intro</a>
          <a class="dropdown-item" href="perl.html#Tutorials">Tutorials</a>
          <a class="dropdown-item" href="perlfaq.html">FAQs</a>
          <a class="dropdown-item" href="perl.html#Reference-Manual">Reference</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="perlop.html">Operators</a>
          <a class="dropdown-item" href="functions.html">Functions</a>
          <a class="dropdown-item" href="variables.html">Variables</a>
          <a class="dropdown-item" href="modules.html">Modules</a>
          <a class="dropdown-item" href="perlutil.html">Utilities</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="perlcommunity.html">Community</a>
          <a class="dropdown-item" href="perlhist.html">History</a>
        </div>
      </li>
    </ul>
    <ul class="navbar-nav">
      <script>
        function set_expand (expand) {
          var perldocdiv = document.getElementById('perldocdiv');
          var width = window.getComputedStyle(perldocdiv).getPropertyValue('max-width');
          var expanded = (width == '' || width == 'none') ? true : false;
          if (expand === null) {
            expand = !expanded;
          }
          if ((expand && !expanded) || (!expand && expanded)) {
            perldocdiv.style.setProperty('max-width', expand ? 'none' : '960px');
            var button_classlist = document.getElementById('content-expand-button').classList;
            if (expand) {
              button_classlist.add('btn-light');
              button_classlist.remove('btn-outline-light');
            } else {
              button_classlist.add('btn-outline-light');
              button_classlist.remove('btn-light');
            }
          }
          return expand;
        }
        function toggle_expand () {
          var expand = set_expand(null);
          document.cookie = 'perldoc_expand=' + (expand ? 1 : 0) + '; path=/; expires=Tue, 19 Jan 2038 03:14:07 UTC';
        }
        function read_expand () {
          return document.cookie.split(';').some(function (item) { return item.indexOf('perldoc_expand=1') >= 0 });
        }
        if (document.readyState === 'loading') {
          document.addEventListener('DOMContentLoaded', function () {
            if (read_expand()) {
              set_expand(true);
            }
          });
        } else if (read_expand()) {
          set_expand(true);
        }
      </script>
      <button id="content-expand-button" type="button" class="btn btn-outline-light d-none d-lg-inline-block mr-2" onclick="toggle_expand()">Expand</button>
    <ul>
    <form class="form-inline" method="get" action="https://perldoc.perl.org/5.35.0/search">
      <input class="form-control mr-3" type="search" name="q" placeholder="Search" aria-label="Search">
    </form>
  </div>
</nav>

    <div id="wrapperlicious" class="container-fluid">
      <div id="perldocdiv">
        <div id="links">
          <a href="perlstyle.html">perlstyle</a>
          <div id="more">
            (<a href="perlstyle.txt">source</a>,
            <a href="https://metacpan.org/pod/perlstyle">CPAN</a>)
          </div>
        </div>
        <div class="leading-notice">
          You are viewing the version of this documentation from Perl 5.35.0.
            This is a development version of Perl.
        </div>
        <h1><a id="toc">CONTENTS</a></h1>
                  <ul>
              <li>
                <a class="text-decoration-none" href="perlstyle.html#NAME">NAME</a>
              </li>
              <li>
                <a class="text-decoration-none" href="perlstyle.html#DESCRIPTION">DESCRIPTION</a>
              </li>
          </ul>

      <h1 id="NAME"><a class="permalink" href="perlstyle.html#NAME">#</a>NAME</h1>

<p>perlstyle - Perl style guide</p>

<h1 id="DESCRIPTION"><a class="permalink" href="perlstyle.html#DESCRIPTION">#</a>DESCRIPTION</h1>

<p>Each programmer will, of course, have his or her own preferences in regards to formatting, but there are some general guidelines that will make your programs easier to read, understand, and maintain.</p>

<p>The most important thing is to use <a href="strict.html">strict</a> and <a href="warnings.html">warnings</a> in all your code or know the reason why not to. You may turn them off explicitly for particular portions of code via <code>no warnings</code> or <code>no strict</code>, and this can be limited to the specific warnings or strict features you wish to disable. The <b>-w</b> flag and <code>$^W</code> variable should not be used for this purpose since they can affect code you use but did not write, such as modules from core or CPAN.</p>

<p>Regarding aesthetics of code lay out, about the only thing Larry cares strongly about is that the closing curly bracket of a multi-line BLOCK should line up with the keyword that started the construct. Beyond that, he has other preferences that aren&#39;t so strong:</p>

<ul>

<li><p>4-column indent.</p>

</li>
<li><p>Opening curly on same line as keyword, if possible, otherwise line up.</p>

</li>
<li><p>Space before the opening curly of a multi-line BLOCK.</p>

</li>
<li><p>One-line BLOCK may be put on one line, including curlies.</p>

</li>
<li><p>No space before the semicolon.</p>

</li>
<li><p>Semicolon omitted in &quot;short&quot; one-line BLOCK.</p>

</li>
<li><p>Space around most operators.</p>

</li>
<li><p>Space around a &quot;complex&quot; subscript (inside brackets).</p>

</li>
<li><p>Blank lines between chunks that do different things.</p>

</li>
<li><p>Uncuddled elses.</p>

</li>
<li><p>No space between function name and its opening parenthesis.</p>

</li>
<li><p>Space after each comma.</p>

</li>
<li><p>Long lines broken after an operator (except <code>and</code> and <code>or</code>).</p>

</li>
<li><p>Space after last parenthesis matching on current line.</p>

</li>
<li><p>Line up corresponding items vertically.</p>

</li>
<li><p>Omit redundant punctuation as long as clarity doesn&#39;t suffer.</p>

</li>
</ul>

<p>Larry has his reasons for each of these things, but he doesn&#39;t claim that everyone else&#39;s mind works the same as his does.</p>

<p>Here are some other more substantive style issues to think about:</p>

<ul>

<li><p>Just because you <i>CAN</i> do something a particular way doesn&#39;t mean that you <i>SHOULD</i> do it that way. Perl is designed to give you several ways to do anything, so consider picking the most readable one. For instance</p>

<pre><code>open(my $fh, &#39;&lt;&#39;, $foo) || die &quot;Can&#39;t open $foo: $!&quot;;</code></pre>

<p>is better than</p>

<pre><code>die &quot;Can&#39;t open $foo: $!&quot; unless open(my $fh, &#39;&lt;&#39;, $foo);</code></pre>

<p>because the second way hides the main point of the statement in a modifier. On the other hand</p>

<pre><code>print &quot;Starting analysis\n&quot; if $verbose;</code></pre>

<p>is better than</p>

<pre><code>$verbose &amp;&amp; print &quot;Starting analysis\n&quot;;</code></pre>

<p>because the main point isn&#39;t whether the user typed <b>-v</b> or not.</p>

<p>Similarly, just because an operator lets you assume default arguments doesn&#39;t mean that you have to make use of the defaults. The defaults are there for lazy systems programmers writing one-shot programs. If you want your program to be readable, consider supplying the argument.</p>

<p>Along the same lines, just because you <i>CAN</i> omit parentheses in many places doesn&#39;t mean that you ought to:</p>

<pre><code>return print reverse sort num values %array;
return print(reverse(sort num (values(%array))));</code></pre>

<p>When in doubt, parenthesize. At the very least it will let some poor schmuck bounce on the % key in <b>vi</b>.</p>

<p>Even if you aren&#39;t in doubt, consider the mental welfare of the person who has to maintain the code after you, and who will probably put parentheses in the wrong place.</p>

</li>
<li><p>Don&#39;t go through silly contortions to exit a loop at the top or the bottom, when Perl provides the <code>last</code> operator so you can exit in the middle. Just &quot;outdent&quot; it a little to make it more visible:</p>

<pre><code>    LINE:
	for (;;) {
	    statements;
	  last LINE if $foo;
	    next LINE if /^#/;
	    statements;
	}</code></pre>

</li>
<li><p>Don&#39;t be afraid to use loop labels--they&#39;re there to enhance readability as well as to allow multilevel loop breaks. See the previous example.</p>

</li>
<li><p>Avoid using <code>grep()</code> (or <code>map()</code>) or `backticks` in a void context, that is, when you just throw away their return values. Those functions all have return values, so use them. Otherwise use a <code>foreach()</code> loop or the <code>system()</code> function instead.</p>

</li>
<li><p>For portability, when using features that may not be implemented on every machine, test the construct in an eval to see if it fails. If you know what version or patchlevel a particular feature was implemented, you can test <code>$]</code> (<code>$PERL_VERSION</code> in <code>English</code>) to see if it will be there. The <code>Config</code> module will also let you interrogate values determined by the <b>Configure</b> program when Perl was installed.</p>

</li>
<li><p>Choose mnemonic identifiers. If you can&#39;t remember what mnemonic means, you&#39;ve got a problem.</p>

</li>
<li><p>While short identifiers like <code>$gotit</code> are probably ok, use underscores to separate words in longer identifiers. It is generally easier to read <code>$var_names_like_this</code> than <code>$VarNamesLikeThis</code>, especially for non-native speakers of English. It&#39;s also a simple rule that works consistently with <code>VAR_NAMES_LIKE_THIS</code>.</p>

<p>Package names are sometimes an exception to this rule. Perl informally reserves lowercase module names for &quot;pragma&quot; modules like <code>integer</code> and <code>strict</code>. Other modules should begin with a capital letter and use mixed case, but probably without underscores due to limitations in primitive file systems&#39; representations of module names as files that must fit into a few sparse bytes.</p>

</li>
<li><p>You may find it helpful to use letter case to indicate the scope or nature of a variable. For example:</p>

<pre><code>$ALL_CAPS_HERE   constants only (beware clashes with perl vars!)
$Some_Caps_Here  package-wide global/static
$no_caps_here    function scope my() or local() variables</code></pre>

<p>Function and method names seem to work best as all lowercase. E.g., <code>$obj-&gt;as_string()</code>.</p>

<p>You can use a leading underscore to indicate that a variable or function should not be used outside the package that defined it.</p>

</li>
<li><p>If you have a really hairy regular expression, use the <code>/x</code> or <code>/xx</code> modifiers and put in some whitespace to make it look a little less like line noise. Don&#39;t use slash as a delimiter when your regexp has slashes or backslashes.</p>

</li>
<li><p>Use the new <code>and</code> and <code>or</code> operators to avoid having to parenthesize list operators so much, and to reduce the incidence of punctuation operators like <code>&amp;&amp;</code> and <code>||</code>. Call your subroutines as if they were functions or list operators to avoid excessive ampersands and parentheses.</p>

</li>
<li><p>Use here documents instead of repeated <code>print()</code> statements.</p>

</li>
<li><p>Line up corresponding things vertically, especially if it&#39;d be too long to fit on one line anyway.</p>

<pre><code>$IDX = $ST_MTIME;
$IDX = $ST_ATIME 	   if $opt_u;
$IDX = $ST_CTIME 	   if $opt_c;
$IDX = $ST_SIZE  	   if $opt_s;

mkdir $tmpdir, 0700	or die &quot;can&#39;t mkdir $tmpdir: $!&quot;;
chdir($tmpdir)      or die &quot;can&#39;t chdir $tmpdir: $!&quot;;
mkdir &#39;tmp&#39;,   0777	or die &quot;can&#39;t mkdir $tmpdir/tmp: $!&quot;;</code></pre>

</li>
<li><p>Always check the return codes of system calls. Good error messages should go to <code>STDERR</code>, include which program caused the problem, what the failed system call and arguments were, and (VERY IMPORTANT) should contain the standard system error message for what went wrong. Here&#39;s a simple but sufficient example:</p>

<pre><code>opendir(my $dh, $dir)	 or die &quot;can&#39;t opendir $dir: $!&quot;;</code></pre>

</li>
<li><p>Line up your transliterations when it makes sense:</p>

<pre><code>tr [abc]
   [xyz];</code></pre>

</li>
<li><p>Think about reusability. Why waste brainpower on a one-shot when you might want to do something like it again? Consider generalizing your code. Consider writing a module or object class. Consider making your code run cleanly with <code>use strict</code> and <code>use warnings</code> in effect. Consider giving away your code. Consider changing your whole world view. Consider... oh, never mind.</p>

</li>
<li><p>Try to document your code and use Pod formatting in a consistent way. Here are commonly expected conventions:</p>

<ul>

<li><p>use <code>C&lt;&gt;</code> for function, variable and module names (and more generally anything that can be considered part of code, like filehandles or specific values). Note that function names are considered more readable with parentheses after their name, that is <code>function()</code>.</p>

</li>
<li><p>use <code>B&lt;&gt;</code> for commands names like <b>cat</b> or <b>grep</b>.</p>

</li>
<li><p>use <code>F&lt;&gt;</code> or <code>C&lt;&gt;</code> for file names. <code>F&lt;&gt;</code> should be the only Pod code for file names, but as most Pod formatters render it as italic, Unix and Windows paths with their slashes and backslashes may be less readable, and better rendered with <code>C&lt;&gt;</code>.</p>

</li>
</ul>

</li>
<li><p>Be consistent.</p>

</li>
<li><p>Be nice.</p>

</li>
</ul>


      </div>
      <div id="footer">
        <p>Perldoc Browser is maintained by Dan Book (<a href="https://metacpan.org/author/DBOOK">DBOOK</a>). Please contact him via the <a href="https://github.com/Grinnz/perldoc-browser/issues">GitHub issue tracker</a> or <a href="mailto:dbook@cpan.org">email</a> regarding any issues with the site itself, search, or rendering of documentation.</p>

<p>The Perl documentation is maintained by the Perl 5 Porters in the development of Perl. Please contact them via the <a href="https://github.com/Perl/perl5/issues">Perl issue tracker</a>, the <a href="https://lists.perl.org/list/perl5-porters.html">mailing list</a>, or <a href="https://kiwiirc.com/client/irc.perl.org/p5p">IRC</a> to report any issues with the contents or format of the documentation.</p>


      </div>
    </div>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.5.1/jquery.slim.min.js" integrity="sha512-/DXTXr6nQodMUiq+IUJYCt2PPOUjrHJ9wFrqpJ3XkgPNOZVfMok7cRw6CSxyCQxXn6ozlESsSh1/sMCTF1rL/g==" crossorigin="anonymous"></script>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.16.1/umd/popper.min.js" integrity="sha512-ubuT8Z88WxezgSqf3RLuNi5lmjstiJcyezx34yIU2gAHonIi27Na7atqzUZCOoY4CExaoFumzOsFQ2Ch+I/HCw==" crossorigin="anonymous"></script>
    <script src="https://stackpath.bootstrapcdn.com/bootstrap/4.5.2/js/bootstrap.min.js" integrity="sha384-B4gt1jrGC7Jh4AgTPSdUtOBvfO8shuf57BaghqFfPlYxofvL8/KUEfYiJOMMV+rV" crossorigin="anonymous"></script>
    <script src="../highlight.pack.js"></script>
    <script>hljs.highlightAll();</script>
  </body>
</html>
